﻿/**
* @private
* @license	GNU GPLv2
*
* Copyright (C) 2007  Polly Jex.
* 
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
* 
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
* GNU General Public License for more details.
* 
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, 
* MA  02110-1301, USA.
*
* @see	http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
*/

package com.kirika.data {
	
	/**
	 * @import
	 */
	
	
	
	/**
	 * Define la API para la implementacion de un modelo basico de Coleccion.
	 * @author	Polly Jex (pollyjex@emc2zen.com.ar)
	 */
	public interface ICollection extends IIterable {
		
		/**
		 * Inserta un nuevo elemento a la coleccion.
		 * @param	value	Elemento a insertar.
		 * @return	Boolean
		 */
		function add( value:* ):Boolean;
		
		/**
		 * Inserta una coleccion de datos a la coleccion.
		 * @param	value	Elementos a insertar.
		 * @return	Boolean
		 */
		function addAll( value:ICollection ):Boolean;
		
		/**
		 * Reinicia la coleccion de datos.
		 * @return	void
		 */
		function clear():void;
		
		/**
		 * Retorna <code>true</code> si la coleccion contiene el elemento especifico, en caso contrario retorna <code>false</code>.
		 * @param	value	Elemento a verificar.
		 * @return	Boolean
		 */
		function contains( value:* ):Boolean;
		
		/**
		 * Retorna <code>true</code> si la coleccion contiene los elemento de la coleccion de datos especifica, en caso contrario retorna <code>false</code>.
		 * @param	value	Elementos a verificar.
		 * @return	Boolean
		 */
		function containsAll( value:ICollection ):Boolean;
		
		/**
		 * Retorna <code>true</code> si la coleccion es igual a la coleccion de datos especifica, en caso contrario retorna <code>false</code>.
		 * @param	value	Elemento a verficar.
		 * @return	Boolean
		 */
		function equals( value:* ):Boolean;
		
		/**
		 * Retorna <code>true</code> si la coleccion no contiene ningun elemento, en caso contrario retorna <code>false</code>.
		 * @return	Boolean
		 */
		function isEmpty():Boolean;
		
		/**
		 * Remueve el elemento de la coleccion.
		 * @param	value	Elemento a remover.
		 * @return	Boolean
		 */
		function remove( value:* ):Boolean;
		
		/**
		 * Remueve todos lo eslementos de la coleccion que contiene la coleccion definida.
		 * @param	value	Elementos a remover.
		 * @return	Boolean
		 */
		function removeAll( value:ICollection ):Boolean;
		
		/**
		 * Retiene solo los elementos de la coleccion que contine la coleccion definida.
		 * @param	value	Elementos a retener.
		 * @return	Boolean
		 */
		function retainAll( value:ICollection ):Boolean;
		
		/**
		 * Busca y retorna la posicion del elemento en la coleccion, retorna <code>-1</code> si el elemento no existe.
		 * @param	value 	Elemento a buscar.
		 * @return	int
		 */
		function search( value:* ):int;
		
		/**
		 * Retorna el numero de datos en la coleccion.
		 * @return	uint
		 */
		function size():uint;
		
		/**
		 * Retorna el contenido de la coleccion en un Array.
		 * @return	Array
		 */
		function toArray():Array;
		
	}
	
}
